/*
 * Copyright 2009 Brett Morgan.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package com.domesticmouse.waveoteditor.client;

import com.domesticmouse.waveoteditor.client.ops.ClientDocOpDidntApply;
import com.domesticmouse.waveoteditor.client.ops.GwtClientDocOp;
import com.google.gwt.user.client.rpc.RemoteService;
import com.google.gwt.user.client.rpc.RemoteServiceRelativePath;

/**
 * Post an edit to the server.
 * 
 * @author brettmorgan
 * 
 */

@RemoteServiceRelativePath("update")
public interface UpdateService extends RemoteService {
	/**
	 * Ask the server to apply an edit at a server revision
	 * 
	 * @param edit
	 *            The edit to apply.
	 * @param atRevision
	 *            The server revision.
	 * @return The transformed composed server edits after revision, transformed
	 *         past the supplied edit.
	 * @throws ClientDocOpDidntApply
	 *             ClientDocOp didn't apply cleanly.
	 */
	ServerResult update(GwtClientDocOp edit, int atRevision) throws ClientDocOpDidntApply;
}
